Transforms forSaveAsBean


SaveAsReportTransform

Formal Parameter Type Default Required Description
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
applyJS STRING   false Indicates JavaScript functionality to be invoked when 'Apply' buttons is pressed.
applyLabel STRING   false Indicates the apply label when no title id is provided.
applyLabelID STRING mstrWeb.134 false Indicates the apply label id according to the application's resource buldles.
canAutoSize BOOLEAN false false Indicates if editor should auto-size to show the contents.
cancelJS STRING   false Indicates JavaScript functionality to be invoked when 'Cancel' buttons is pressed.
JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined by AbstractAppTransform.getScriptClass()).
If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
cancelLabel STRING   false Indicates the cancel label when no title id is provided.
cancelLabelID STRING mstrWeb.2140 false Indicates the cancel label id according to the application's resource buldles.
checkImage STRING btnCheck.gif false Formal parameter: The icon to use to submit the parent folders select box in HTML mode. Used only in HTML mode. For DHTML mode, the CSS contains the image
checkKeepPrompt BOOLEAN true false In the case of a prompted report, indicates whether the simple option for keeping the reprot prompted is checked by default.
closeJS STRING   false Indicates JavaScript functionality to be invoked when 'Close' buttons is pressed.
JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined by AbstractAppTransform.getScriptClass()).
If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
confirmOWHelpTopic STRING Save_reports_and_objects.htm false Indicates the help topic for inner confirm overwrite dialog.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
createFolderJS STRING   false Formal parameter: The JavaScript code to execute when clicking on the create Folder Button
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssPrefix STRING   false Prefix to append to all css class names.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
disableOKButton BOOLEAN false false Indicates whether to disable the OK button
displayFormatPickerName STRING displayFormatPicker false Indicates the id of a system picker that contains the possible display options for the data result
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    editorContentsStyle STRING   false Indicates the style name to be used for the div containing the editor contents
    editorElements INTEGER 127 false Indicates the elements to display by the editor. The flags are taken from the EnumEditorDisplayFlags enumeration.
    editorLayoutFile STRING   false Indicates the name of the definition file associated with the editor.
    editorSubType STRING   false Indicates the subtype to be used for the STY attribute for the editor container
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    folderBrowserStyle STRING FolderStyleSaveAsBrowser false Indicates the style to use when rendering the contents of the folder to save the object to.
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    helpPage STRING   false Indicates the sub-page for the help for the editor.
    helpTopic STRING   false Indicates the help topic for the help page of the editor.
    helpType STRING user false Indicates the type of help topic this editor uses.
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    incrementalFetchNavigationType INTEGER 5 false Formal parameter that specifies which type of incremental fetch navigation will be enabled. Allowed values: a valid bitwise combination of EnumIncrementalFetchProperties.NAVIGATION_BUTTONS_FIRST_LAST and/or EnumIncrementalFetchProperties.NAVIGATION_BUTTONS_PREVIOUS_NEXT
    incrementalFetchPageBlock INTEGER 5 false Formal parameter: Indicates the number of pages to show per block for incremental fetch
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    navigateOnSubmit BOOLEAN false false Indicates if the editor will move to a new page after the user clicks on the OK button
    newFloderHelpTopic STRING Create_a_new_folder.htm false Indicates the help topic for inner new folder dialog.
    okJS STRING   false Indicates JavaScript functionality to be invoked when 'OK' buttons is pressed.
    JS functions set on this parameter are expected to be defined on the JS bone rendered by this editor (defined by AbstractAppTransform.getScriptClass()).
    If the function set is not on the appropriate editor bone, it must be called as: "customJS('alert(\'in\');"
    okLabel STRING   false Indicates the OK label when no title id is provided.
    okLabelID STRING mstrWeb.1442 false Indicates the OK label id according to the application's resource buldles.
    orientation INTEGER 2 false Indicates the orientation the dialog to render will have.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = not docked
  • 1 = docked horizontally
  • 2 = docked vertically
    		•
    orientationsAllowed INTEGER 3 false Indicates the orientation modes allowed for the dialog to render.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = no orientations allowed
  • 1 = horizontal orientation allowed
  • 2 = vertical orientation allowed
  • 3 = 1 + 2 (both horiz & vert orientations are allowed)
    		•
    promptString STRING   false  
    promptStringID STRING   false  
    renderForm BOOLEAN false false Indicates whether the editor will create its own form.
    renderLinksAncestors BOOLEAN true false This formal parameter controls whether we display the ancestors of the Folder links in the ancestor list.
    resizeLevel INTEGER 0 false Indicates whether the component can be resized vertically/horizontally or both or none. Possible values are AbstractAppTransform.RESIZE_NONE, AbstractAppTransform.RESIZE_VERTICAL, AbstractAppTransform.RESIZE_HORIZONTAL, AbstractAppTransform.RESIZE_ALL
    saveButtonLabelID STRING mstrWeb.1442 false Indicates the descriptor Id for the save button.
    saveLabelID STRING mstrWeb.945 false Indicates the descriptor Id for the save as label.
    saveNonPromptedEmbedFilterEmbedTemplate INTEGER 64 false Value of the save as flags for a non prompted report that defines whether filter and template are embedded or linked.
    This flag will be used only in case the flag to show the options (showSaveAsOptions) for saving a report are not shown.
    The value comes from EnumDSSXMLReportSaveAsFlags
    saveNonPromptedFilter INTEGER 1024 false Value of the save as flags for saving a the filter of a non prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.
    saveNonPromptedTemplate INTEGER 2048 false Value of the save as flags for saving a the template of a non prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.
    savePromptedEmbedFilterEmbedTemplate INTEGER 16454 false Value of the save as flags for a prompted report that defines whether filter and template are embedded or linked.
    This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.
    The value comes from EnumDSSXMLReportSaveAsFlags
    savePromptedFilter INTEGER 9216 false Value of the save as flags for saving a the filter of a prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.
    savePromptedTemplate INTEGER 18432 false Value of the save as flags for saving a the template of a prompted report. This flag will be used only in case the flag to show the options(showSaveAsOptions) for saving a report are not shown.
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    showCreateFolderButton BOOLEAN true false Indicates if the create folder toggle button is to be shown or not. The value can true or false. If the value is false, the button to open the create folder dialog will not be shown. If the value is set to false and the value of the showCreateFolderDialog formal parameter is set to true, the create folder dialog will always be shown open on the save page. This formal parameter is applicaable only in DHTML mode as in HTML mode the create fodler dialog is always open.
    showCreateFolderDialog BOOLEAN true false Indicates if the create new folder dialog is to be shown or not. The value can true or false. If the value is false, then the user will never be able to see the create new folder dialog and he will never see the toggle button used to open the create folder dialog either. Please note the the toggle button is available only in the DHTML mode.
    showCurrentInAncestorsList BOOLEAN true false Formal parameter: Inidcates whether to show the current item in the ancestors list
    showSaveAsOptions BOOLEAN true false Flag to decide whether to show the save as options at all. If this flag is set to false, only then will we use all the other save as flag related formal parameters.
    titleLabel STRING   false Indicates the title when no title id is provided.
    titleLabelID STRING   false Indicates the title id according to the application's resource buldles.
    type STRING   false

    This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

    Possible values for this property are bone ids, its usage depends on the page.
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.